Skip to content

docs(api): Add python venv as a pre-requisite for API local dev#7722

Closed
tushar5526 wants to merge 1 commit into
Flagsmith:mainfrom
tushar5526:api-setup-docs
Closed

docs(api): Add python venv as a pre-requisite for API local dev#7722
tushar5526 wants to merge 1 commit into
Flagsmith:mainfrom
tushar5526:api-setup-docs

Conversation

@tushar5526
Copy link
Copy Markdown
Contributor

@tushar5526 tushar5526 commented Jun 7, 2026

setup

Thanks for submitting a PR! Please check the boxes below:

  • I have read the Contributing Guide.
  • I have added information to docs/ if required so people know about the feature.
  • I have filled in the "Changes" section below.
  • I have filled in the "How did you test this code" section below.

Changes

Contributes to

Mention that a user needs to have a virtual environment created and activated. Most new distro releases uphelds PEP 668 and prevents users from globally installing python packages by default.

Please describe.

How did you test this code?

On Ubuntu Noble:

sudo apt install python3.12-venv
git clone https://github.com/Flagsmith/flagsmith.git
cd flagsmith
python3 -m venv .venv
source .venv/bin/activate
make install

Please describe.

@tushar5526 tushar5526 requested a review from a team as a code owner June 7, 2026 14:44
@tushar5526 tushar5526 requested review from emyller and removed request for a team June 7, 2026 14:44
@vercel
Copy link
Copy Markdown

vercel Bot commented Jun 7, 2026

@tushar5526 is attempting to deploy a commit to the Flagsmith Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the api Issue related to the REST API label Jun 7, 2026
@tushar5526 tushar5526 changed the title doc(api): Add python venv as a pre-requisite for API local dev docs(api): Add python venv as a pre-requisite for API local dev Jun 7, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 7, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.37%. Comparing base (4ffbf74) to head (1cdce17).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #7722      +/-   ##
==========================================
- Coverage   98.52%   98.37%   -0.16%     
==========================================
  Files        1445     1445              
  Lines       55083    55079       -4     
==========================================
- Hits        54273    54185      -88     
- Misses        810      894      +84     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tushar5526 tushar5526 closed this Jun 7, 2026
@tushar5526 tushar5526 deleted the api-setup-docs branch June 7, 2026 15:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Issue related to the REST API

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants